home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / lib / python2.5 / idlelib / CallTips.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2008-10-29  |  9KB  |  288 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.5)
  3.  
  4. '''CallTips.py - An IDLE Extension to Jog Your Memory
  5.  
  6. Call Tips are floating windows which display function, class, and method
  7. parameter and docstring information when you type an opening parenthesis, and
  8. which disappear when you type a closing parenthesis.
  9. '''
  10. import sys
  11. import types
  12. import CallTipWindow
  13. from HyperParser import HyperParser
  14. import __main__
  15.  
  16. class CallTips:
  17.     menudefs = [
  18.         ('edit', [
  19.             ('Show call tip', '<<force-open-calltip>>')])]
  20.     
  21.     def __init__(self, editwin = None):
  22.         if editwin is None:
  23.             self.editwin = None
  24.             return None
  25.         
  26.         self.editwin = editwin
  27.         self.text = editwin.text
  28.         self.calltip = None
  29.         self._make_calltip_window = self._make_tk_calltip_window
  30.  
  31.     
  32.     def close(self):
  33.         self._make_calltip_window = None
  34.  
  35.     
  36.     def _make_tk_calltip_window(self):
  37.         return CallTipWindow.CallTip(self.text)
  38.  
  39.     
  40.     def _remove_calltip_window(self, event = None):
  41.         if self.calltip:
  42.             self.calltip.hidetip()
  43.             self.calltip = None
  44.         
  45.  
  46.     
  47.     def force_open_calltip_event(self, event):
  48.         '''Happens when the user really wants to open a CallTip, even if a
  49.         function call is needed.
  50.         '''
  51.         self.open_calltip(True)
  52.  
  53.     
  54.     def try_open_calltip_event(self, event):
  55.         """Happens when it would be nice to open a CallTip, but not really
  56.         neccesary, for example after an opening bracket, so function calls
  57.         won't be made.
  58.         """
  59.         self.open_calltip(False)
  60.  
  61.     
  62.     def refresh_calltip_event(self, event):
  63.         '''If there is already a calltip window, check if it is still needed,
  64.         and if so, reload it.
  65.         '''
  66.         if self.calltip and self.calltip.is_active():
  67.             self.open_calltip(False)
  68.         
  69.  
  70.     
  71.     def open_calltip(self, evalfuncs):
  72.         self._remove_calltip_window()
  73.         hp = HyperParser(self.editwin, 'insert')
  74.         sur_paren = hp.get_surrounding_brackets('(')
  75.         if not sur_paren:
  76.             return None
  77.         
  78.         hp.set_index(sur_paren[0])
  79.         name = hp.get_expression()
  80.         if (not name or not evalfuncs) and name.find('(') != -1:
  81.             return None
  82.         
  83.         arg_text = self.fetch_tip(name)
  84.         if not arg_text:
  85.             return None
  86.         
  87.         self.calltip = self._make_calltip_window()
  88.         self.calltip.showtip(arg_text, sur_paren[0], sur_paren[1])
  89.  
  90.     
  91.     def fetch_tip(self, name):
  92.         '''Return the argument list and docstring of a function or class
  93.  
  94.         If there is a Python subprocess, get the calltip there.  Otherwise,
  95.         either fetch_tip() is running in the subprocess itself or it was called
  96.         in an IDLE EditorWindow before any script had been run.
  97.  
  98.         The subprocess environment is that of the most recently run script.  If
  99.         two unrelated modules are being edited some calltips in the current
  100.         module may be inoperative if the module was not the last to run.
  101.  
  102.         '''
  103.         
  104.         try:
  105.             rpcclt = self.editwin.flist.pyshell.interp.rpcclt
  106.         except:
  107.             rpcclt = None
  108.  
  109.         if rpcclt:
  110.             return rpcclt.remotecall('exec', 'get_the_calltip', (name,), { })
  111.         else:
  112.             entity = self.get_entity(name)
  113.             return get_arg_text(entity)
  114.  
  115.     
  116.     def get_entity(self, name):
  117.         '''Lookup name in a namespace spanning sys.modules and __main.dict__'''
  118.         if name:
  119.             namespace = sys.modules.copy()
  120.             namespace.update(__main__.__dict__)
  121.             
  122.             try:
  123.                 return eval(name, namespace)
  124.             return None
  125.  
  126.         
  127.  
  128.  
  129.  
  130. def _find_constructor(class_ob):
  131.     
  132.     try:
  133.         return class_ob.__init__.im_func
  134.     except AttributeError:
  135.         for base in class_ob.__bases__:
  136.             rc = _find_constructor(base)
  137.             if rc is not None:
  138.                 return rc
  139.                 continue
  140.         
  141.  
  142.  
  143.  
  144. def get_arg_text(ob):
  145.     '''Get a string describing the arguments for the given object'''
  146.     argText = ''
  147.     if ob is not None:
  148.         argOffset = 0
  149.         if type(ob) in (types.ClassType, types.TypeType):
  150.             fob = _find_constructor(ob)
  151.             if fob is None:
  152.                 
  153.                 fob = lambda : pass
  154.             else:
  155.                 argOffset = 1
  156.         elif type(ob) == types.MethodType:
  157.             fob = ob.im_func
  158.             argOffset = 1
  159.         else:
  160.             fob = ob
  161.         if type(fob) in [
  162.             types.FunctionType,
  163.             types.LambdaType]:
  164.             
  165.             try:
  166.                 realArgs = fob.func_code.co_varnames[argOffset:fob.func_code.co_argcount]
  167.                 if not fob.func_defaults:
  168.                     pass
  169.                 defaults = []
  170.                 defaults = list(map((lambda name: '=%s' % repr(name)), defaults))
  171.                 defaults = [
  172.                     ''] * (len(realArgs) - len(defaults)) + defaults
  173.                 items = map((lambda arg, dflt: arg + dflt), realArgs, defaults)
  174.                 if fob.func_code.co_flags & 4:
  175.                     items.append('...')
  176.                 
  177.                 if fob.func_code.co_flags & 8:
  178.                     items.append('***')
  179.                 
  180.                 argText = ', '.join(items)
  181.                 argText = '(%s)' % argText
  182.  
  183.         
  184.         doc = getattr(ob, '__doc__', '')
  185.         if doc:
  186.             doc = doc.lstrip()
  187.             pos = doc.find('\n')
  188.             if pos < 0 or pos > 70:
  189.                 pos = 70
  190.             
  191.             if argText:
  192.                 argText += '\n'
  193.             
  194.             argText += doc[:pos]
  195.         
  196.     
  197.     return argText
  198.  
  199. if __name__ == '__main__':
  200.     
  201.     def t1():
  202.         '''()'''
  203.         pass
  204.  
  205.     
  206.     def t2(a, b = None):
  207.         '''(a, b=None)'''
  208.         pass
  209.  
  210.     
  211.     def t3(a, *args):
  212.         '''(a, ...)'''
  213.         pass
  214.  
  215.     
  216.     def t4(*args):
  217.         '''(...)'''
  218.         pass
  219.  
  220.     
  221.     def t5(a, *args):
  222.         '''(a, ...)'''
  223.         pass
  224.  
  225.     
  226.     def t6(a, b = None, *args, **kw):
  227.         '''(a, b=None, ..., ***)'''
  228.         pass
  229.  
  230.     
  231.     class TC:
  232.         '''(a=None, ...)'''
  233.         
  234.         def __init__(self, a = None, *b):
  235.             '''(a=None, ...)'''
  236.             pass
  237.  
  238.         
  239.         def t1(self):
  240.             '''()'''
  241.             pass
  242.  
  243.         
  244.         def t2(self, a, b = None):
  245.             '''(a, b=None)'''
  246.             pass
  247.  
  248.         
  249.         def t3(self, a, *args):
  250.             '''(a, ...)'''
  251.             pass
  252.  
  253.         
  254.         def t4(self, *args):
  255.             '''(...)'''
  256.             pass
  257.  
  258.         
  259.         def t5(self, a, *args):
  260.             '''(a, ...)'''
  261.             pass
  262.  
  263.         
  264.         def t6(self, a, b = None, *args, **kw):
  265.             '''(a, b=None, ..., ***)'''
  266.             pass
  267.  
  268.  
  269.     
  270.     def test(tests):
  271.         ct = CallTips()
  272.         failed = []
  273.         for t in tests:
  274.             expected = t.__doc__ + '\n' + t.__doc__
  275.             name = t.__name__
  276.             arg_text = ct.fetch_tip(name)
  277.             if arg_text != expected:
  278.                 failed.append(t)
  279.                 print '%s - expected %s, but got %s' % (t, expected, get_arg_text(entity))
  280.                 continue
  281.         
  282.         print '%d of %d tests failed' % (len(failed), len(tests))
  283.  
  284.     tc = TC()
  285.     tests = (t1, t2, t3, t4, t5, t6, TC, tc.t1, tc.t2, tc.t3, tc.t4, tc.t5, tc.t6)
  286.     test(tests)
  287.  
  288.